README.md HEAD (534f41e8) Text, 4.70 KB
Tc9d1d9# Reticulum MeshChatX
[Tff7b72Русский](Te6edf3lang/README.ru.md) | [Tff7b72Deutsch](Te6edf3lang/README.de.md) | [Tff7b72Italiano](Te6edf3lang/README.it.md) | [Tff7b72中文](Te6edf3lang/README.zh.md) | [Tff7b72日本語](Te6edf3lang/README.ja.md)
Fork of [Tff7b72Reticulum MeshChat](Te6edf3https://github.com/liamcottle/reticulum-meshchat) by Liam Cottle. MeshChatX adds LXST voice calls, RRC relay chat, Nomad map overlays, plugins, raw SQLite (no Peewee), and Electron 41 desktop builds. Independent from upstream. Not affiliated with it.
Tff7b72- Website: [Tff7b72meshchatx.com](Te6edf3https://meshchatx.com)
Tff7b72- Forum: [Tff7b72forum.meshchatx.com](Te6edf3https://forum.meshchatx.com/)
Tff7b72- Source: [Tff7b72github.com/Quad4-Software/MeshChatX](Te6edf3https://github.com/Quad4-Software/MeshChatX)
Tff7b72- Mirror: [Tff7b72lavaforge.org/Reticulum-Things/MeshChatX](Te6edf3https://lavaforge.org/Reticulum-Things/MeshChatX)
Tff7b72- PyPI: [Tff7b72reticulum-meshchatx](Te6edf3https://pypi.org/project/reticulum-meshchatx/)
Tff7b72- Changelog: [Tff7b72CHANGELOG.md](Te6edf3CHANGELOG.md)
Tff7b72- Donate: [Tff7b72donate.md](Te6edf3donate.md)
Tff7b72- LXMF: Ta5d6ff`f489752fbef161c64d65e385a4e9fc74`
Tff7b72- Umbrel: [Tff7b72apps.umbrel.com/app/meshchatx](Te6edf3https://apps.umbrel.com/app/meshchatx)
<a href="https://apps.obtainium.imranr.dev/redirect.html?r=obtainium://add/https://github.com/Quad4-Software/MeshChatX"><img src="https://raw.githubusercontent.com/ImranR98/Obtainium/main/assets/graphics/badge_obtainium.png" height="60" alt="Get it on Obtainium"></a>
rngit NomadNet Node: Ta5d6ff`132f67e79d9b24aad014e93015fb858f:/page/index.mu`
Tc9d1d9## Install
Requirements for source builds: Python 3.11+, Node.js 24+, pnpm 11.1.2, UV. Web UI needs Safari 16.4, Chrome 111, or Firefox 128+. PyPI and Docker ship the built frontend (no Node on the runtime host).
Tc9d1d9### Docker
Ta5d6ff```Ta5d6ffbash
docker compose up -d
Ta5d6ff```
Ta5d6ff```Ta5d6ffbash
docker run -d --name reticulum-meshchatx Tffea00\
-p T79c0ff127.0.0.1:8000:8000 Tffea00\
-v meshchatx-config:/config Tffea00\
ghcr.io/quad4-software/meshchatx:latest
Ta5d6ff```
Images: Ta5d6ff`quad4io/meshchatx` (Docker Hub) and Ta5d6ff`ghcr.io/quad4-software/meshchatx`. Hardened and extra tags are in [Tff7b72Installation](Te6edf3docs/en/installation.md).
Tc9d1d9### PyPI (pip, pipx, uv)
Package: [Ta5d6ff`reticulum-meshchatx`](https://pypi.org/project/reticulum-meshchatx/)
Ta5d6ff```Ta5d6ffbash
pip install reticulum-meshchatx
T8b949e# or
pipx install reticulum-meshchatx
T8b949e# or
uv tool install reticulum-meshchatx
Ta5d6ff```
Ta5d6ff```Ta5d6ffbash
meshchatx --headless --host T79c0ff127.0.0.1
Ta5d6ff```
Ta5d6ff`meshchat` is the same entry point. Release wheels from GitHub also work: Ta5d6ff`pip install ./reticulum_meshchatx-*-py3-none-any.whl`.
Tc9d1d9### From source (git clone, make, task)
HTTPS:
Ta5d6ff```Ta5d6ffbash
git clone https://github.com/Quad4-Software/MeshChatX.git
Tffa657cd MeshChatX
Ta5d6ff```
Over Reticulum (rngit / Ta5d6ff`git-remote-rns`):
Ta5d6ff```Ta5d6ffbash
git clone rns://06a54b505bb67b25ef3f8097e8001edc/public/MeshChatX
Tffa657cd MeshChatX
Ta5d6ff```
Then install and run with either Make or Task (same targets):
Ta5d6ff```Ta5d6ffbash
make install Tff7b72&& make build Tff7b72&& make run
Ta5d6ff```
Ta5d6ff```Ta5d6ffbash
task install Tff7b72&& task build Tff7b72&& task run
Ta5d6ff```
Or step through UV / pnpm yourself:
Ta5d6ff```Ta5d6ffbash
corepack Tffa657enable
pnpm install --frozen-lockfile
uv sync --group dev
pnpm run build-frontend
uv run python -m meshchatx.meshchat --headless --host T79c0ff127.0.0.1
Ta5d6ff```
AppImage, deb, rpm, Electron, and Android: [Tff7b72Installation](Te6edf3docs/en/installation.md) and [Tff7b72Building](Te6edf3docs/en/building.md).
Current version is 4.8.6.
Tc9d1d9## Docs
| Guide | Covers |
| ----------------------------------------------------------- | -------------------------------------- |
| [Tff7b72Getting started](Te6edf3docs/en/getting-started.md) | First-day flow |
| [Tff7b72Installation](Te6edf3docs/en/installation.md) | Docker details, packages, CLI flags |
| [Tff7b72Building](Te6edf3docs/en/building.md) | Offline builds, packaging, Android APK |
| [Tff7b72Development](Te6edf3docs/en/development.md) | task/make, versioning, locales |
| [Tff7b72Identities and security](Te6edf3docs/en/identity-and-security.md) | Backups, corruption recovery, wipe |
| [Tff7b72Platform guides](Te6edf3docs/en/platform-guides/) | Pi, Termux, Quest, Linux sandbox |
Tc9d1d9## Changes from Reticulum MeshChat
LXST calls, [Tff7b72RRC](Te6edf3https://rrc.kc1awv.net/0) relay chat, MBTiles map plus remote KMZ/KML/GeoJSON overlays, raw SQL instead of Peewee, native fetch instead of Axios, Electron 41 (Node 24), wheels with built frontend, i18n, pnpm and UV.
Tc9d1d9## Security, license, credits
Tff7b72- [Tff7b72SECURITY.md](Te6edf3SECURITY.md) · [Tff7b72LEGAL.md](Te6edf3LEGAL.md) · [Tff7b72donate.md](Te6edf3donate.md)
Tff7b72- Project-owned code is 0BSD. Upstream MeshChat portions remain MIT. Full text: [Tff7b72LICENSE](Te6edf3LICENSE).
Tff7b72- Credits: [Tff7b72Liam Cottle](Te6edf3https://github.com/liamcottle) (original MeshChat), [Tff7b72RFnexus](Te6edf3https://github.com/RFnexus) (micron parser JS), [Tff7b72markqvist](Te6edf3https://github.com/markqvist) (Reticulum, LXMF, LXST).
──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────